Determines the name and size of every named fork belonging to a file or directory.

OSErr PBIterateForksSync (
    FSForkIOParam *paramBlock
);

paramBlock

A pointer to a parameter block.

function result

A result code.

DISCUSSION

The relevant fields of the parameter block are:

• ioCompletion

  On input, a pointer to a completion routine.

• ioResult

  On output, the result code of the function.

• ref

  On input, the file or directory containing the forks.

• forkIterator

  A pointer to the structure which maintains state between calls for a given FSRef. Before the first call, set the initialize field to 0. The forkIterator will be updated after the call completes; the updated iterator should be passed into the next call.

• outForkName

  On output, the name of the fork in Unicode.

• positionOffset

  On output, the logical size of the fork, in bytes. This field is optional; if you don’t want the value, set the pointer to NULL.

• allocationAmount

  On output, the fork’s physical size (i.e. the amount of space allocated on disk), in bytes. This field is optional; if you don’t want the value, set the pointer to NULL.

Since information is returned about one fork at a time, several calls may be required to iterate through all the forks. There is no guarantee about the order in which forks are returned; the order may vary between iterations.

AVAILABILITY

Supported in Carbon. Available in Mac OS 9, and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)